home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / COMMUNIC / COMMUTIL / 2258.ZIP / EZENTR35.ZIP / EAZENTR3.DOC < prev    next >
Text File  |  1990-05-07  |  18KB  |  399 lines
  1.  
  2.                                EAZENTR3.EXE V3.57
  3.                                ------------------
  4.          Front Door - Bulletin Program for EaziLink V3 and Eazihost V1
  5.          -------------------------------------------------------------
  6.  
  7.      7th May 1990
  8.  
  9.      Disclaimer
  10.      ----------
  11.  
  12.      This program is being put  into  the  Public  Domain and may be freely
  13.      distributed  on  the  understanding  that  no  responsibility  can  be
  14.      accepted for any problems arising  from  its  use.  To the best of our
  15.      knowledge, it is 'Bug free' and serves its intended purpose.
  16.  
  17.      No charge, other than a nominal charge for duplication and postage may
  18.      be made for it and it should only  be supplied as a single ARC, ZIP or
  19.      PAK file called EAZENTR3.ARC, EAZENTR3.ZIP or EAZENTR3.PAK, containing
  20.      the EAZENTR3.EXE, EAZENTR3.DOC and TEXTFILE.BAT files.
  21.  
  22.      Included files
  23.      --------------
  24.  
  25.      EAZENTR3.EXE   - Program File.
  26.      EAZENTR3.MNU   - Example Main Menu file.
  27.      *.MNU          - Skeleton example menu files.
  28.      *.HLP          - Sample EaziHost Help files.
  29.      *.NWS          - Sample News files.
  30.      *.INF          - Sample Information files.
  31.      *.BAT          - Example Batch files to call doors etc.
  32.  
  33.      Note: If you wish to use  the  sample  files,  it will be necessary to
  34.      edit them to change the name of  the  BB and also any paths, filenames
  35.      etc, which may differ from one installation to another.
  36.  
  37.  
  38.      Overview
  39.      --------
  40.  
  41.      The main objective of this  program  is  to  enable the Sysop to bring
  42.      items to the callers attention before  they get involved with the main
  43.      Bulletin Board. It  may,  however,  be  used  in  any  situation where
  44.      EaziLink/EaziHost allows the running of door programs and its uses are
  45.      not just limited to providing help  or  news,  as  it can be used as a
  46.      means to run further door programs.
  47.  
  48.      EazEntr3 is ideal  as  a  means  of  notifying  people  of  any system
  49.      changes, items of interest etc and  also  provides a means of offering
  50.      initial guidance to new users and  detailed  help with making the most
  51.      of the BB. It also provides  a  mechanism  to offer a questionnaire to
  52.      new users, or, for that matter, any other program.
  53.  
  54.      Lastly, it allows special access  for  people designated as Sub-Sysops.
  55.      Sub-sysop options on the menu are  only  displayed  if the caller is a
  56.      Sub-Sysop. This can be used to  run  a  program,  shell out to DOS, or
  57.      lead to a further menu with a range of options.
  58.  
  59.      The principle behind EazEntr3 is based on  a  main menu, with up to 16
  60.      options,  from  which  either  further  menus  may  be  called,  files
  61.      displayed, or other programs run.
  62.  
  63.      In addition, parameters may  be  specified  to  determine how, or even
  64.      whether, menu entries are displayed,  depending  on  the status of the
  65.      caller.
  66.  
  67.  
  68.      Setting up EazEntr3
  69.      -------------------
  70.  
  71.      It is recommended that all the files  which are a part of this program
  72.      are placed into a  sub-directory  of  their  own, for convenience, but
  73.      this is not essential as long  as EAZENTR3.EXE and EAZENTR3.MNU are in
  74.      the same directory.
  75.  
  76.      Note: Some of the included  files  contain  pathnames which may differ
  77.      from the names of the directories and  drives on your set up, in which
  78.      case they will require editing.
  79.  
  80.  
  81.      EAZENTR3.MNU file
  82.      -----------------
  83.  
  84.      Note: This file is required and the name MUST NOT BE CHANGED.
  85.  
  86.      EAZENTR3.MNU specifies the entries to  be  displayed  in the main menu
  87.      and the effects there selection will have.
  88.  
  89.      Menus are displayed vertically and  may  consist  of up to 16 entries.
  90.      The character used to select  each  option  is  also specified and the
  91.      Description should also contain the required character.
  92.  
  93.      EAZENTR3.MNU serves two purposes.
  94.  
  95.      Firstly, three optional special lines may  be included, to specify the
  96.      text for the menu header, the  prompt  for input and a Sub-Sysop file,
  97.      containing the names of any Sub-sysops, if required.
  98.  
  99.      Each is preceded by its own identifier:-
  100.  
  101.      HOSTMAIN:  - Required. Full path to  Host  Main Directory. Required if
  102.                   error messages are to be appended to SYSTEM.ERR file used
  103.                   by EaziHost. If this entry  is omitted, a SYSTEM.ERR file
  104.                   will be created in the current directory.
  105.  
  106.      VERT:      - Optional. The entry  takes  the  same  format  as used in
  107.                   EaziLink/Host VERTICAL.MNU file  and allows customisation
  108.                   of the way that the selection characters are displayed.
  109.  
  110.                   The default colours used  in  EaziLink/Host  will be used
  111.                   unless EaziLink pseudo codes are included in the entry.
  112.  
  113.      HEAD:      - Optional. A  single  line  containing  the  required menu
  114.                   heading.
  115.  
  116.                   The default colours used  in  EaziLink/Host  will be used
  117.                   unless EaziLink pseudo codes are included in the entry.
  118.  
  119.      PROMPT:    - Optional. A single line  containing the required 'request
  120.                   for selection of an option'.
  121.  
  122.                   The default colours used  in  EaziLink/Host  will be used
  123.                   unless EaziLink pseudo codes are included in the entry.
  124.  
  125.      SUBSYSOP:  - Optional.  The  full  path  and   name  of  a  text  file
  126.                   containing the First and Last Names of all sub-sysops.
  127.  
  128.                   The subsysop file entries  should  contain ONLY the First
  129.                   and Last names, with one person per line.
  130.  
  131.      Secondly, the remainder of the file may contain UP TO 16 entries to be
  132.      offered by the Front Door Menu. The 'X' and/or 'B' options are counted
  133.      as part of the 16 possible entries.
  134.  
  135.      These entries take the following format:-
  136.  
  137.              t; k; Descrip; Name; d
  138.  
  139.         t       - Type of entry. Options are:-
  140.  
  141.                   X - Exit from program. One entry of this type is REQUIRED
  142.                   D - run a DOOR program
  143.                   M - multiple entry - goes to a sub-menu
  144.                   S - Single file to be displayed
  145.                   B - jump straight Back to Main Menu from any Sub-Menu.
  146.                       NOTE: This option is only valid in Sub-Menus
  147.                   Note: One entry of type 'X'  MUST  be present in the Main
  148.                         menu. Sub-Menus may contain either an 'X', or a 'B'
  149.                         entry or both types of  entry,  but at least one or
  150.                         the other is required.
  151.  
  152.         k       - Key character for menu  selection.  'Q' for 'Quit' option
  153.                   etc. Any single  character.  Can  be  a  single digit, if
  154.                   preferred.
  155.  
  156.                   Note: Each entry must be  an  exclusive character. If the
  157.                   same character is used for  more  than one entry, it will
  158.                   only be possible to select the first.
  159.  
  160.         Descrip - Text description  of  entry  to  be  displayed.  EaziLink
  161.                   pseudo codes may  be  included  as  long  as  the overall
  162.                   length of the string is  not  more than 60 characters. If
  163.                   no  colour  codes  are  included,  EaziLink/Host  default
  164.                   colours will be used.
  165.  
  166.         Name    - This varies according to type of entry.
  167.  
  168.                   Paths may be included:-
  169.  
  170.                   With D - should be the  full  command  line  of  the door
  171.                            program to be called.
  172.                            Certain EaziLink variables may be passed:-
  173.                            %ver, %first, %last, %newuser, %ansi, %hotkey
  174.  
  175.                            Note: If a  path  is  included, EazEntr3 selects
  176.                            the specified directory and drive as the current
  177.                            directory and drive before  the program or batch
  178.                            file is run and  restores  the original settings
  179.                            on return.
  180.  
  181.                   With M - should be the name  of  the menu file containing
  182.                            details of the entries in the Sub-Menu. Any file
  183.                            name or  extension  may  be  used.  (See SubMenu
  184.                            below)
  185.  
  186.                   With S - should be the name of the file to be displayed.
  187.  
  188.                   With X - Leave blank, as it serves no purpose.
  189.  
  190.  
  191.         d       - Used to determine  how,  or  whether,  the  entry will be
  192.                   displayed. Certain characters may be used in combination,
  193.                   although normally only one will be required.
  194.  
  195.                   Valid characters are:-
  196.  
  197.                   F      - flash entry if a First time user.
  198.  
  199.                   O      - show Only if the person is a first time caller.
  200.  
  201.                   S      - show only if  a  Sub-sysop  list  exists and the
  202.                            caller is on the list.
  203.  
  204.                   U      - flash entry if Updated or new since date of last
  205.                            call.
  206.  
  207.                   Note for EaziLink Host Mode users:
  208.  
  209.                   Only the 'S' option has  any  relevance to EaziLink users
  210.                   as the necessary variables  to  be  checked for dates and
  211.                   NewUser status are only  implemented  in EaziHost. If the
  212.                   others are used, they will just be ignored.
  213.  
  214.      Note: All semi-colons must be present even if entries are left blank.
  215.  
  216.      The '^I' pseudo code  (the  TAB  code)  may  be  used to offset menus,
  217.      headers, prompts  and  the  positioning  of  the  selection characters
  218.      (using VERT:) to the right.
  219.  
  220.      Note: Whilst  the  '^I'  pseudo  code  is  recognised  by  EaziHost as
  221.      standard, EaziLink does not recognise  it  and  it will only work with
  222.      EazEntr3. Do not expect it to work in EaziLink V3!
  223.  
  224.      Note: If NO  colour  codes  are  included  in  the 'HEAD:', 'PROMPT:',
  225.      'VERT:'  and  'Descrip'   fields,   the   default   colours   used  in
  226.      EaziLink/Host will be used. If  they  are  provided, they will be used
  227.      instead of the defaults.
  228.  
  229.      See the EAZENTR3.MNU file for examples of entries.
  230.  
  231.      If the 'U' option is  specified,  EazEntr3  will compare the date/time
  232.      stamp of the file specified for the entry  in the Name field and if it
  233.      is the same as, or more recent than, the DateLastOn, the entry will be
  234.      marked '* NEW *' (or '* PLEASE READ *' in the case of a new user). Not
  235.      applicable for use with EaziLink V3 Host Mode.
  236.  
  237.      Similarly, if the caller is a new  user  and the entry type is 'F' for
  238.      First time caller, it will be marked '* PLEASE READ *'. Not applicable
  239.      for use with EaziLink V3 Host Mode.
  240.  
  241.      When ANSI mode is selected, the special markers will also flash.
  242.  
  243.  
  244.      Sub-Menu Files
  245.      --------------
  246.  
  247.      Sub-menu files have exactly the  same  format as EAZENTR3.MNU, but may
  248.      be given any name. We use names with a '.MNU' extension for clarity.
  249.  
  250.      Note: The 'HOSTMAIN:'  entry  is  only  required  in  EAZENTR3.MNU. If
  251.      included in other menus, it will be ignored.
  252.  
  253.      Sub-Menus may be nested to  a  considerable  depth, although this will
  254.      rarely be required. The precise depth  is  determined by the amount of
  255.      computer memory available, but is extremely  unlikely to be reached in
  256.      normal circumstances. The program has  been  tested  to a depth of 100
  257.      sub-menus, but if you do  encounter  strange results, try reducing the
  258.      depth of sub-menu nesting.
  259.  
  260.      Note: The 'B' type (See 'EAZENTR3.MNU File' above) may be used to jump
  261.      straight back to the Main  Menu  from  a  sub-menu. This may be useful
  262.      when using nested sub-menus,  as  it  removes  the  need  to work back
  263.      through all the sub-menus. Both 'X' and  'B' types may be used in sub-
  264.      menus to provide  a  choice  of  'backing  up'  through  the menus, or
  265.      jumping straight back.
  266.  
  267.  
  268.      Setting up EazEntr3
  269.      -------------------
  270.  
  271.      EazEntr3 is primarily intended for use  with EaziHost, although it may
  272.      also be used with  EaziLink.  The  following instructions describe its
  273.      use with EaziHost.
  274.  
  275.      EazEntr3 runs as an 'EaziLink  Type  2  Door'  program  and may be run
  276.      wherever EaziHost provides  the  facility  to  run  a  door.  The most
  277.      natural place  to  run  it  is  either  via  ENTRY1.HST  or,  perhaps,
  278.      ENTRY2.HST.  It  may  also  be  useful   to   run  it  from  the  main
  279.      EaziLink/EaziHost Doors menu as well as from The ENTRY?.HST locations,
  280.      enabling callers to get extended on-line help whilst in the main BB.
  281.  
  282.      The following is an example of a typical entry in ENTRY1.HST:-
  283.  
  284.            0; Y; 2; Descrip; C:\ENTRANCE\EAZENTR3.EXE V%Ver H%HotKey A%Ansi
  285.                                    D%DateLastOn N%NewUser F%First L%Last CN
  286.  
  287.      (Note: The two lines of the entry should really be one long line, with
  288.      the 'A%ansi' separated from the 'D%DateLastOn' by a space)
  289.  
  290.      Note for EaziLink Users:
  291.  
  292.      The %DateLastOn and %NewUser variables  are only supported in EaziHost
  293.      and should be omitted from the  line  when used with EaziLink. %ver is
  294.      not supported by Eazilink V3, but may  be included. The effect of this
  295.      is that it is not possible to  make  use of the 'F' and 'O' parameters
  296.      to flash new entries or  display  entries  only  to  New Users, nor to
  297.      flash entries which have been updated since the last call with the 'U'
  298.      option.
  299.  
  300.         0       - specifies an access  level  of  zero,  so  all  users can
  301.                   access the program.
  302.  
  303.         Y       - Specifies that EaziHost's 'Soft  re-boot recovery' should
  304.                   be used if necessary.
  305.  
  306.         2       - Specifies the program is a Type 2 Door program.
  307.  
  308.         Descrip - Serves no purpose when used  in  ENTRY?.HST files and may
  309.                   be blank, but should be  the  description to be displayed
  310.                   when used in DOORS.HST or any other Doors which display a
  311.                   menu of options.
  312.  
  313.      The remainder of the line is the command to call EazEntr3 and the path
  314.      to the program should be included if the program is not in the current
  315.      directory, as well  as  the  '.EXE'  extension.  The EaziLink/EaziHost
  316.      %variables are required to pass the necessary information to EazEntr3.
  317.  
  318.      Note: Each %variable is preceded by  a single character, with NO space
  319.      following and is required.  The  'CN'  suppresses  the  display of the
  320.      Copyright message.
  321.  
  322.  
  323.      Using a Batch file to call EazEntr3
  324.      -----------------------------------
  325.  
  326.      In certain circumstances it may  be  necessary  to  call EazEntr3 via a
  327.      batch file, so that other tasks  may  be  executed as well as EazEntr3
  328.      run. If so, the %variables should be passed to the batch file and then
  329.      passed on to the program  from  the  batch  file. It is also important
  330.      that the batch  file  changes  to  the  directory containing EazEntr3,
  331.      before running it.
  332.  
  333.      Example Batch file
  334.      ------------------
  335.  
  336.      Assuming ENTRY1.HST contains the following  entry  to run a batch file
  337.      called ENTRY1.BAT:-
  338.  
  339.       0;Y;2;Dummy;C:\EAZIHOST\ENTRY1.BAT V%Ver H%HotKey A%Ansi D%DateLastOn
  340.                                                   N%NewUser F%First L%Last
  341.  
  342.      The batch file would contain:-
  343.  
  344.         ECHO OFF
  345.         REM Do what you want here, such as run a Quote creation program
  346.         REM then change to \ENTRANCE directory
  347.         CD \ENTRANCE
  348.         EAZENTR3 %1 %2 %3 %4 %5 %6 %7 CN
  349.         REM Do whatever you want here also.
  350.  
  351.  
  352.      Error Messages
  353.      --------------
  354.  
  355.      With the exception of  error  messages  which  occur through incorrect
  356.      parameters being passed to EazEntr3  (which  will  be picked up during
  357.      initial installation of the program), all system errors as a result of
  358.      incorrect paths, filenames etc are displayed  on screen AND written to
  359.      the SYSTEM.ERR file in the Host Main Directory.
  360.  
  361.      SYSTEM.ERR is created by EaziHost  and  provides  a convenient way for
  362.      the Sysop to check on errors.  If  no  SYSTEM.ERR file is found, a new
  363.      file will be created. The  entry  is  in  the  same  format as used by
  364.      EaziHost and includes the name  of  the  program  from which the error
  365.      originated, the current system date and a description of the error.
  366.  
  367.  
  368.      History
  369.      -------
  370.  
  371.      3.50 - 05/01/90 - Initial pre-release Beta test version.
  372.      3.51 - 21/01/90 - First release version.
  373.                      - includes a number of enhancements over the Beta-test
  374.                        version, including 'nested' menus.
  375.      3.52 - 02/02/90 - System Errors are now written  to SYSTEM.ERR file in
  376.                        Host Main Directory, in line with EaziHost.
  377.                      - Makes full use of  COLOUR.HST and VERTICAL.MNU files
  378.                        unless prompts have been re-configured in one of the
  379.                        Menu files.
  380.      3.55 - 04/04/90 - Only minor changes, mostly  as  a result of modified
  381.                        libraries to increase efficiency.
  382.      3.57 - 07/05/90 - Added facility to jump straight back to Main Menu
  383.                        from any nested sub-menu. See 'EAZENTR3.MNU File'
  384.                        and 'Sub-Menu Files' for details.
  385.                      - Fixed bug which caused %DateLastOn and %Ver not to
  386.                        be passed on to another program correctly.
  387.  
  388.  
  389.      David Foster
  390.      H.L.C. Services
  391.      High Leys
  392.      Crook
  393.      Kendal
  394.      Cumbria
  395.      LA8 8LF
  396.  
  397.                                       END
  398.  
  399.